/*****************************************************************************
 *   Copyright 2005 Tim A Wang
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 *
 ****************************************************************************/
package com.jb.framework;

import java.util.List;


/**
 * Interface to be implemented by components that needs to be persisted by
 * the persistent manager.
 *
 * @author Anping Wang
 * @version 1.0
 */
public interface Persistable {
    /**
     * Returns a list of children of type persistable.
     *
     * @return List of children.
     */
    public List getChildren();

    /**
     * Setter for its unique Id
     *
     * @param componentId
     */
    public void setId(String componentId);

    /**
     * Returns the unique Id for this object.
     *
     * @return Identification
     */
    public String getId();

    public void setPersistentManager(PersistentManager persistentManager);

    public PersistentManager getPersistentManager();

    /**
     * Add a child to this component
     *
     * @param p child persistable.
     */
    public void addChild(Persistable p);

    /**
     * Called after the instance is created.
     *
     * @param ctx then runtime context.
     */
    public void postCreate(PersistentContext ctx);
}
